4.2.3.3 批量删除用户-基于外部id
可通过此接口在用户目录批量删除用户。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/user/bulkDeleteByExternalIdList请求方式：
POST
请求头（Header）
- 请求体（Body）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识，在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local。外部用户目录示例： custom01339（唯一标识无需携带@） |
| externalIdList | 外部 id 列表 | 是 | string[] | 用户外部 id 列表 |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/user/bulkDeleteByExternalIdList?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"directoryDomain": "local",
"externalIdList": [
"202cb962ac59075b",
"81dc9bdb52d04dc2"
]
}'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | |
| msg | 描述信息 | string | |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {},
"msg": "请求成功",
"traceId": "00ca70c9adde821f"
}
错误码